<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Tutorial: 文档</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Tutorial: 文档</h1>

    <section>

<header>
    

    <h2>文档</h2>
</header>

<article>
    <hr>
<h3>本文档是采用JSDOC@3.6.6 生成的</h3>
<p><strong>1.查看文档</strong></p>
<p><strong>每次在代码中添加新的JSDOC注释  都需要运行一次下方代码重新生成静态HTML文档</strong></p>
<pre class="prettyprint source"><code>npm run doc
</code></pre>
<p><strong>2.目录介绍</strong></p>
<pre class="prettyprint source"><code>根路径 
└─doc
    │
    └─ templates // 模板文件目录 这里并没有使用jsdoc自带的模版，可以去下载第三方模版放到这个里面
    │
    └─ tutorials // 文档导航目录（不设置这个，文档只有首页和API部分）
    │
    └─ www // 文档最终生成的目录
        │ 
        └─ // index.html  // 文档首页
    │
    └─config.json  // 配置文件

</code></pre>
<p><strong>3.文档配置</strong></p>
<p><a href="https://jsdoc.app/about-configuring-jsdoc.html#specifying-the-source-type">配置传送门</a></p>
<p>此框架加入了一些esLint规则，配置在 package.json.eslintConfig 中；</p>
<p>这些规则能让你的代码更规范 更利于维护。当然如果不喜欢可以手动去掉。</p>
<ul>
<li>&quot;off&quot;或0-关闭规则</li>
<li>&quot;warn&quot;或1-将该规则作为警告打开（不影响退出代码）</li>
<li>&quot;error&quot;或2-将规则作为错误打开（退出代码将为1）</li>
</ul>
<table>
<thead>
<tr>
<th>规则</th>
<th>作用</th>
</tr>
</thead>
<tbody>
<tr>
<td>no-console</td>
<td>“控制台”选项 （代码中是否允许console 的存在）</td>
</tr>
<tr>
<td>no-debugger</td>
<td>“debugger”选项（代码中是否允许debugger 的存在）</td>
</tr>
<tr>
<td>no-dupe-args</td>
<td>禁止在<code>function</code>定义中重复参数</td>
</tr>
<tr>
<td>no-dupe-else-if</td>
<td>在if-else-if链中禁止重复条件</td>
</tr>
<tr>
<td>no-dupe-keys</td>
<td>禁止在对象文字中使用重复键</td>
</tr>
<tr>
<td>no-empty</td>
<td>禁止空块语句</td>
</tr>
<tr>
<td>no-unreachable</td>
<td>在return，throw，continue和break语句之后禁止无法访问的代码</td>
</tr>
<tr>
<td>block-scoped-var</td>
<td>在定义变量的范围内强制使用变量</td>
</tr>
<tr>
<td>no-empty-function</td>
<td>禁止空函数</td>
</tr>
<tr>
<td>no-eval</td>
<td>禁止使用<code>eval（）</code></td>
</tr>
<tr>
<td>no-redeclare</td>
<td>禁止变量重新声明</td>
</tr>
<tr>
<td>indent</td>
<td>强制一致的缩进</td>
</tr>
<tr>
<td>max-lines</td>
<td>强制每个文件最大行数</td>
</tr>
<tr>
<td>max-lines-per-function</td>
<td>强制执行函数中的最大代码行数</td>
</tr>
<tr>
<td>max-nested-callbacks</td>
<td>强制回调可以嵌套的最大深度</td>
</tr>
<tr>
<td>new-cap</td>
<td>要求构造函数名称以大写字母开头</td>
</tr>
<tr>
<td>no-bitwise</td>
<td>禁止按位运算符</td>
</tr>
<tr>
<td>no-multiple-empty-lines</td>
<td>禁止多个空行</td>
</tr>
<tr>
<td>quotes</td>
<td>强制使用反引号，双引号或单引号的一致使用</td>
</tr>
<tr>
<td>no-duplicate-imports</td>
<td>禁止重复的模块导入</td>
</tr>
<tr>
<td>no-var</td>
<td>需要<code>let</code>或<code>const</code>而不是<code>var</code></td>
</tr>
<tr>
<td>semi</td>
<td>要求或禁止使用分号</td>
</tr>
<tr>
<td>comma-dangle</td>
<td>要求或禁止使用拖尾逗号</td>
</tr>
<tr>
<td>no-unused-vars</td>
<td>消除未使用的变量，函数和函数的参数。</td>
</tr>
</tbody>
</table>
<ul>
<li>
<p>max-lines 说明：</p>
<p>该规则强制每个文件最大行数，以帮助维护和降低复杂性。</p>
<p><font color='red'> 这里设置了每个文件的最大行数不应该超过666行，如果大于666行，请合理的拆分组件 </font></p>
<p>请注意，如果文件以换行符结尾，大多数编辑器将在末尾显示一个额外的空行。此规则不计入额外的行数。
选项：</p>
<p>&quot;max&quot;（默认300）强制文件中的最大行数</p>
<p>&quot;skipBlankLines&quot;: true 忽略纯粹由空格组成的行。</p>
<p>&quot;skipComments&quot;: true 忽略仅包含注释的行</p>
<p><a href="https://eslint.org/docs/rules/max-lines">更多max-lines配置</a></p>
</li>
<li>
<p>max-lines-per-function 说明：</p>
<p>该规则强制每个函数的最大行数，以帮助维护和降低复杂性。</p>
<p><font color='red'>这里设置了每个函数的最大行数不应该超过80行，如果大于80行，请考虑拆分函数</font></p>
<p><a href="https://eslint.org/docs/rules/max-lines-per-function">更多max-lines-per-function配置</a></p>
</li>
</ul>
<p><a href="https://eslint.org/docs/rules/">EsLint规则传送门</a></p>
</article>

</section>

</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Tutorials</h3><ul><li><a href="tutorial-文档.html">文档</a></li></ul><h3>Global</h3><ul><li><a href="global.html#login">login</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Wed Nov 04 2020 11:25:50 GMT+0800 (中国标准时间)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>